<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpLeastSquareMults.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpLeastSquareMults_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">IpLeastSquareMults.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="IpLeastSquareMults_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (C) 2004, 2006 International Business Machines and others.</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// Authors:  Carl Laird, Andreas Waechter              IBM    2004-09-23</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef __IPLEASTSQUAREMULTS_HPP__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define __IPLEASTSQUAREMULTS_HPP__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="IpAugSystemSolver_8hpp.html">IpAugSystemSolver.hpp</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="IpEqMultCalculator_8hpp.html">IpEqMultCalculator.hpp</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>{</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html">   22</a></span><span class="keyword">class </span><a class="code hl_class" href="classIpopt_1_1LeastSquareMultipliers.html">LeastSquareMultipliers</a>: <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1EqMultiplierCalculator.html">EqMultiplierCalculator</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#aa794a494128422f006c26911c9095224">   32</a></span>   <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#aa794a494128422f006c26911c9095224">LeastSquareMultipliers</a>(</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>      <a class="code hl_class" href="classIpopt_1_1AugSystemSolver.html">AugSystemSolver</a>&amp; augSysSolver</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>   );</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
<div class="foldopen" id="foldopen00037" data-start="{" data-end="}">
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#a0743eb1c771525a7605e9ca85118568a">   37</a></span>   <span class="keyword">virtual</span> <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#a0743eb1c771525a7605e9ca85118568a">~LeastSquareMultipliers</a>()</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>   { }</div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#aa9464bd68e3ceeb7fa2fc4703397a2a9">   41</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#aa9464bd68e3ceeb7fa2fc4703397a2a9">InitializeImpl</a>(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp; options,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>      <span class="keyword">const</span> std::string&amp; prefix</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>   );</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#a109407ee9cb2deab977e1f146ee161ca">   51</a></span>   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#a109407ee9cb2deab977e1f146ee161ca">CalculateMultipliers</a>(</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>      <a class="code hl_class" href="classIpopt_1_1Vector.html">Vector</a>&amp; y_c,</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>      <a class="code hl_class" href="classIpopt_1_1Vector.html">Vector</a>&amp; y_d</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>   );</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#a2f601b2dc8f52f9538a4a85c2a9469b9">   68</a></span>   <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#a2f601b2dc8f52f9538a4a85c2a9469b9">LeastSquareMultipliers</a>();</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#ac2e7e96d57ba472385ede60b59beffa7">   71</a></span>   <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#ac2e7e96d57ba472385ede60b59beffa7">LeastSquareMultipliers</a>(</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1LeastSquareMultipliers.html">LeastSquareMultipliers</a>&amp;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>   );</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#ad0bc94d047022ca131d9cd369efedf1a">   75</a></span>   <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1LeastSquareMultipliers.html#ad0bc94d047022ca131d9cd369efedf1a">operator=</a>(</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>      <span class="keyword">const</span> <a class="code hl_class" href="classIpopt_1_1LeastSquareMultipliers.html">LeastSquareMultipliers</a>&amp;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>   );</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classIpopt_1_1LeastSquareMultipliers.html#aca3496bd87afac74f62bdd9f509fc8cf">   81</a></span>   <a class="code hl_class" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;AugSystemSolver&gt;</a> <a class="code hl_variable" href="classIpopt_1_1LeastSquareMultipliers.html#aca3496bd87afac74f62bdd9f509fc8cf">augsyssolver_</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>};</div>
</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aIpAugSystemSolver_8hpp_html"><div class="ttname"><a href="IpAugSystemSolver_8hpp.html">IpAugSystemSolver.hpp</a></div></div>
<div class="ttc" id="aIpEqMultCalculator_8hpp_html"><div class="ttname"><a href="IpEqMultCalculator_8hpp.html">IpEqMultCalculator.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1AugSystemSolver_html"><div class="ttname"><a href="classIpopt_1_1AugSystemSolver.html">Ipopt::AugSystemSolver</a></div><div class="ttdoc">Base class for Solver for the augmented system.</div><div class="ttdef"><b>Definition</b> <a href="IpAugSystemSolver_8hpp_source.html#l00036">IpAugSystemSolver.hpp:37</a></div></div>
<div class="ttc" id="aclassIpopt_1_1EqMultiplierCalculator_html"><div class="ttname"><a href="classIpopt_1_1EqMultiplierCalculator.html">Ipopt::EqMultiplierCalculator</a></div><div class="ttdoc">Base Class for objects that compute estimates for the equality constraint multipliers y_c and y_d.</div><div class="ttdef"><b>Definition</b> <a href="IpEqMultCalculator_8hpp_source.html#l00021">IpEqMultCalculator.hpp:22</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html">Ipopt::LeastSquareMultipliers</a></div><div class="ttdoc">Class for calculator for the least-square equality constraint multipliers.</div><div class="ttdef"><b>Definition</b> <a href="IpLeastSquareMults_8hpp_source.html#l00022">IpLeastSquareMults.hpp:23</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_a0743eb1c771525a7605e9ca85118568a"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#a0743eb1c771525a7605e9ca85118568a">Ipopt::LeastSquareMultipliers::~LeastSquareMultipliers</a></div><div class="ttdeci">virtual ~LeastSquareMultipliers()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition</b> <a href="IpLeastSquareMults_8hpp_source.html#l00037">IpLeastSquareMults.hpp:37</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_a109407ee9cb2deab977e1f146ee161ca"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#a109407ee9cb2deab977e1f146ee161ca">Ipopt::LeastSquareMultipliers::CalculateMultipliers</a></div><div class="ttdeci">virtual bool CalculateMultipliers(Vector &amp;y_c, Vector &amp;y_d)</div><div class="ttdoc">This method computes the least-square estimates for y_c and y_d at the current point.</div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_a2f601b2dc8f52f9538a4a85c2a9469b9"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#a2f601b2dc8f52f9538a4a85c2a9469b9">Ipopt::LeastSquareMultipliers::LeastSquareMultipliers</a></div><div class="ttdeci">LeastSquareMultipliers()</div><div class="ttdoc">Default Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_aa794a494128422f006c26911c9095224"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#aa794a494128422f006c26911c9095224">Ipopt::LeastSquareMultipliers::LeastSquareMultipliers</a></div><div class="ttdeci">LeastSquareMultipliers(AugSystemSolver &amp;augSysSolver)</div><div class="ttdoc">Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_aa9464bd68e3ceeb7fa2fc4703397a2a9"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#aa9464bd68e3ceeb7fa2fc4703397a2a9">Ipopt::LeastSquareMultipliers::InitializeImpl</a></div><div class="ttdeci">virtual bool InitializeImpl(const OptionsList &amp;options, const std::string &amp;prefix)</div><div class="ttdoc">overloaded from AlgorithmStrategyObject</div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_ac2e7e96d57ba472385ede60b59beffa7"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#ac2e7e96d57ba472385ede60b59beffa7">Ipopt::LeastSquareMultipliers::LeastSquareMultipliers</a></div><div class="ttdeci">LeastSquareMultipliers(const LeastSquareMultipliers &amp;)</div><div class="ttdoc">Copy Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_aca3496bd87afac74f62bdd9f509fc8cf"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#aca3496bd87afac74f62bdd9f509fc8cf">Ipopt::LeastSquareMultipliers::augsyssolver_</a></div><div class="ttdeci">SmartPtr&lt; AugSystemSolver &gt; augsyssolver_</div><div class="ttdoc">augmented system solver to be used for solving the linear system</div><div class="ttdef"><b>Definition</b> <a href="IpLeastSquareMults_8hpp_source.html#l00081">IpLeastSquareMults.hpp:81</a></div></div>
<div class="ttc" id="aclassIpopt_1_1LeastSquareMultipliers_html_ad0bc94d047022ca131d9cd369efedf1a"><div class="ttname"><a href="classIpopt_1_1LeastSquareMultipliers.html#ad0bc94d047022ca131d9cd369efedf1a">Ipopt::LeastSquareMultipliers::operator=</a></div><div class="ttdeci">void operator=(const LeastSquareMultipliers &amp;)</div></div>
<div class="ttc" id="aclassIpopt_1_1OptionsList_html"><div class="ttname"><a href="classIpopt_1_1OptionsList.html">Ipopt::OptionsList</a></div><div class="ttdoc">This class stores a list of user set options.</div><div class="ttdef"><b>Definition</b> <a href="IpOptionsList_8hpp_source.html#l00032">IpOptionsList.hpp:33</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SmartPtr_html"><div class="ttname"><a href="classIpopt_1_1SmartPtr.html">Ipopt::SmartPtr</a></div><div class="ttdoc">Template class for Smart Pointers.</div><div class="ttdef"><b>Definition</b> <a href="IpSmartPtr_8hpp_source.html#l00164">IpSmartPtr.hpp:165</a></div></div>
<div class="ttc" id="aclassIpopt_1_1Vector_html"><div class="ttname"><a href="classIpopt_1_1Vector.html">Ipopt::Vector</a></div><div class="ttdoc">Vector Base Class.</div><div class="ttdef"><b>Definition</b> <a href="IpVector_8hpp_source.html#l00047">IpVector.hpp:48</a></div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
